<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - Network</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 200px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 230px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}

		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/BlankCustomMapType.html">BlankCustomMapType</a></li>
	
	<li><a href="../symbols/CircularCoordToLatLngMapper.html">CircularCoordToLatLngMapper</a></li>
	
	<li><a href="../symbols/CoordToLatLngBoundsMapper.html">CoordToLatLngBoundsMapper</a></li>
	
	<li><a href="../symbols/CoordToLatLngMapper.html">CoordToLatLngMapper</a></li>
	
	<li><a href="../symbols/CustomMapType.html">CustomMapType</a></li>
	
	<li><a href="../symbols/Edge.html">Edge</a></li>
	
	<li><a href="../symbols/LinearCoordToLatLngMapper.html">LinearCoordToLatLngMapper</a></li>
	
	<li><a href="../symbols/Network.html">Network</a></li>
	
	<li><a href="../symbols/Node.html">Node</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class Network
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_Users_jhughes_Sites_gmapnet_source_OpenNetworks_v01.js.html">OpenNetworks_v01.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Network.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/Network.html#constructor">Network</a></b>(div_id, nodes, edges, map_type,, map_opts, latlng_mapper)
							</div>
							<div class="description">Network constructor - 
   Builds a network object that contains the specified nodes and edges, placing
   the network in the HTML div div_id in a Google Maps viewer with
   options as provided.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Network.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.addControlElement">addControlElement</a></b>(position, elt)
								</div>
								<div class="description">Adds a control element to the map, specifying position and element</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.bindEventToNode">bindEventToNode</a></b>(idx, eventType, func)
								</div>
								<div class="description">Binds an event to a single node (Node object), specified by the given index (looks in 
  the object's node list to find the node; returns false if node does not exist</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.bindEventToNodes">bindEventToNodes</a></b>(eventType, func)
								</div>
								<div class="description">Binds an event to all nodes (Node objects) in the network</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.hideNodes">hideNodes</a></b>()
								</div>
								<div class="description">Hide the nodes in this network.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.initEdges">initEdges</a></b>(edgeArray)
								</div>
								<div class="description">Initializes this Network's edges using edge array input
Each input edge should have values 'from' and 'to' as indices indicating which
nodes are connected by this edge (using the ordering of the input nodes)
and may include an optional 'weight'</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.initialize">initialize</a></b>(map_opts)
								</div>
								<div class="description">Initialize a new Network</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.initNodes">initNodes</a></b>(nodeArray)
								</div>
								<div class="description">initializes a list of nodes using the array input
nodes should have three fields:  name, xcoord, ycoord</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.showNodes">showNodes</a></b>()
								</div>
								<div class="description">Show the nodes in this network.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Network.<b><a href="../symbols/Network.html#.updateEdges">updateEdges</a></b>(edgeArray)
								</div>
								<div class="description">Updates the current edge array with the edges in the input array
Assumes numerical edge indices correspond to the order of nodes in the node array</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>Network</b>(div_id, nodes, edges, map_type,, map_opts, latlng_mapper)
				</div>
				
				<div class="description">
					Network constructor - 
   Builds a network object that contains the specified nodes and edges, placing
   the network in the HTML div div_id in a Google Maps viewer with
   options as provided.
					<br /><i>Author: </i>James M. Hughes.
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								 <b>div_id</b>
								
							</dt>
								<dd>Id of HTML element (div) where map will reside</dd>
						
							<dt>
								 <b>nodes</b>
								
							</dt>
								<dd>Array of Node objects</dd>
						
							<dt>
								 <b>edges</b>
								
							</dt>
								<dd>Array of Edge objects</dd>
						
							<dt>
								 <b>map_type,</b>
								
							</dt>
								<dd>if not null, must be implementation of CustomMapType interface</dd>
						
							<dt>
								 <b>map_opts</b>
								
							</dt>
								<dd>JSON object of map options (see Google Maps API ref.)</dd>
						
							<dt>
								 <b>latlng_mapper</b>
								
							</dt>
								<dd>Mapper from coordinate space to LatLngBounds (type CoordToLatLngBounds)</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".addControlElement"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>addControlElement</b>(position, elt)
					
					</div>
					<div class="description">
						Adds a control element to the map, specifying position and element
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>position</b>
									
								</dt>
								<dd>One of static values google.maps.ControlPosition.* (see Google Maps API v3)</dd>
							
								<dt>
									<b>elt</b>
									
								</dt>
								<dd>HTML element to be placed in map controls</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".bindEventToNode"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>bindEventToNode</b>(idx, eventType, func)
					
					</div>
					<div class="description">
						Binds an event to a single node (Node object), specified by the given index (looks in 
  the object's node list to find the node; returns false if node does not exist
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>idx</b>
									
								</dt>
								<dd>Index of node</dd>
							
								<dt>
									<b>eventType</b>
									
								</dt>
								<dd>(string) indicates what event should be listened for (i.e., 'click', 'drag')</dd>
							
								<dt>
									<b>func</b>
									
								</dt>
								<dd>function reference; to be executed on event (may be empty function, but not null)</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>true, on success; false otherwise</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".bindEventToNodes"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>bindEventToNodes</b>(eventType, func)
					
					</div>
					<div class="description">
						Binds an event to all nodes (Node objects) in the network
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>eventType</b>
									
								</dt>
								<dd>(string) indicates what event should be listened for (i.e., 'click', 'drag')</dd>
							
								<dt>
									<b>func</b>
									
								</dt>
								<dd>function reference; to be executed on event (may be empty function, but not null)</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>true, on success; false otherwise</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".hideNodes"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>hideNodes</b>()
					
					</div>
					<div class="description">
						Hide the nodes in this network.
 Provides interactivity function that can be utilized from within the map itself or externally via page controls.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name=".initEdges"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>initEdges</b>(edgeArray)
					
					</div>
					<div class="description">
						Initializes this Network's edges using edge array input
Each input edge should have values 'from' and 'to' as indices indicating which
nodes are connected by this edge (using the ordering of the input nodes)
and may include an optional 'weight'
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>edgeArray</b>
									
								</dt>
								<dd>Array of Edge objects</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".initialize"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>initialize</b>(map_opts)
					
					</div>
					<div class="description">
						Initialize a new Network
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>map_opts</b>
									
								</dt>
								<dd>JSON object with map options</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".initNodes"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>initNodes</b>(nodeArray)
					
					</div>
					<div class="description">
						initializes a list of nodes using the array input
nodes should have three fields:  name, xcoord, ycoord
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>nodeArray</b>
									
								</dt>
								<dd>Array of Node objects</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".showNodes"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>showNodes</b>()
					
					</div>
					<div class="description">
						Show the nodes in this network.
 Provides interactivity function that can be utilized from within the map itself or externally via page controls.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name=".updateEdges"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Network.</span><b>updateEdges</b>(edgeArray)
					
					</div>
					<div class="description">
						Updates the current edge array with the edges in the input array
Assumes numerical edge indices correspond to the order of nodes in the node array
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>edgeArray</b>
									
								</dt>
								<dd>Array of Edge objects</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Wed Dec 08 2010 15:35:35 GMT-0500 (EST)
		</div>
	</body>
</html>
